home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / opus / ofu102.zip / README.OFU < prev   
Text File  |  1993-03-30  |  8KB  |  194 lines
  1.  
  2.  Opus Filename Updater for the Opus CBCS v1.7x/v1.8x Files Database
  3.                    Copyright 1993 by Kevin Silcox
  4.  
  5.                                                           March 30, 1993
  6.  
  7. Disclaimer
  8. ----------
  9.     This software is available "AS IS".  It is not guaranteed to work at
  10. all.  If it trashes your system or ruins your life, you have been warned.
  11. I am not responsible for any damages incurred from the use or misuse of
  12. this software.  There is also no fee to use this software to keep with
  13. the spirit of Opus.
  14.  
  15.         ***********************************************************
  16.         **** ALWAYS HAVE A RECENT BACKUP COPY OF YOUR DATABASE ****
  17.         ***********************************************************
  18.  
  19. ---===---
  20.     OFU allows you to automatically change filenames within the Opus
  21. Files Database via a command-line interface.  If OFU updates a filename
  22. then the file information (date/time, size) will be updated to match
  23. the new filename.  This program should be very handy for those that do
  24. automatic virus scanning of newly uploaded files, archive conversion,
  25. or when converting archives to a different format.
  26.  
  27.     OFU will automatically detect the version of files database you are
  28. using and use the correct structures.  Any structure changes made after
  29. the date of this release may cause problems with the operation of OFU.
  30. As of this release OFU works with Opus versions 1.7x, and the 1.99/1.8x
  31. beta and gamma releases.
  32.  
  33.     The files that OFU uses are the following:
  34.     (R-O) = Read-Only       (R/W) = Read/Write
  35.  
  36. (R-O)   PRM file                To locate the system files if necessary
  37. (R-O)   FILESBBS.ADX            To get valid area numbers and area
  38.                                   offsets within the database
  39. (R-O)   SYSFILE.DAT             To get default download paths
  40. (R/W)   FILESBBS.DAT            To read/update file information
  41.  
  42.     The FILESBBS.DAT file is the only one that is ever changed, and is
  43. opened in DENYWRITE share mode.  If this is an incorrect method please
  44. bring it to my attention.  Thanks.
  45. ---===---
  46.  
  47.     NOTICE:  This program will abort if it detects that Opus is
  48. currently active for the task it's processing.  If the files database
  49. is common between two or more tasks then you have to take the necessary
  50. precautions to make sure OFU doesn't run while another task is active.
  51. It is *highly* recommended that Opus is not active *at all* when running
  52. OFU since the database will need to be re-indexed (OFARE) if any filenames
  53. get changed.  See Errorlevels below.
  54.  
  55.     It may not be a requirement to run OFARE after changing a filename in
  56. the database.  I only recommend that since I've heard what can happen to
  57. the user database if the NDX file isn't maintained.  However, Opus has
  58. displayed the correct information for a file area after the names have been
  59. changed with OFU and OFARE has NOT been run.
  60.  
  61.     The RAM requirement is based entirely on the buffer size, and the number
  62. of areas being processed (along with the download path length).  The base
  63. memory required to load OFU is somewhere around 30Kb.  Take the base value
  64. and add the following values to get the approximate RAM requirement:
  65.   - Buffer size
  66.   - Number of areas times 30 bytes.  Each area takes up 10 bytes plus the
  67.     length of the download path string (20 bytes is an approximation
  68.     for the download path string length).
  69.  
  70.     So processing 50 areas with a 4Kb buffer would require somewhere around
  71. 35Kb.  (50 * 30 + 4096 + 30720 = 36316 bytes or approximately 36Kb)
  72.  
  73. --=={*-------------------------------------------------*}==--
  74.  
  75. Errorlevels:
  76.  11: One or more filenames deleted/undeleted (run OFARE at your convenience)
  77.  10: One or more filenames changed (recommended to run OFARE immediately)
  78.   6: Error writing to file
  79.   5: Error reading file
  80.   4: Attempt to use potential invalid wildcard sequence
  81.   3: Current task active
  82.   2: Memory allocation error
  83.   1: Unsuccessful (General Error)
  84.   0: Nothing changed
  85.  
  86.  
  87. ------------------------------------------------------
  88. Usage:
  89.  
  90.   OFU oldName newName cmd [cmd] [...]
  91.  
  92.         When changing filename(s).
  93.  
  94.            or
  95.  
  96.   OFU Name cmd [cmd] [...]
  97.  
  98.         When using the Delete/Undelete option.
  99.  
  100.  
  101. Valid Command-line Switches (cmd):
  102.  
  103.   #       A valid area number (i.e. 1 {not the # symbol}) for
  104.         processing.
  105.  
  106.   /A      Process all areas (self explanatory).  All areas will be
  107.         searched for filename replacement.
  108.  
  109.   /B#     Multiply # by 2048 bytes (2Kb) for the memory buffer size.
  110.         This value will be used when allocating any buffer to read
  111.         data from a file (except the Area list which is determined
  112.         by the number of areas, and the size of the Download Path
  113.         strings).  The default value is 2 which uses a buffer size
  114.         of 4Kb (and should give good performance).  Valid values
  115.         are from 1 to 32.
  116.  
  117.   /D[U]    Delete/Undelete file(s) from database.  The first filename
  118.         listed on the command-line will be the one marked for
  119.         deletion/undeletion from the specified file area(s).  The
  120.         undelete is only useful if you just marked a file for deletion
  121.         (on accident?) and haven't re-indexed the database yet.
  122.  
  123.   /Q      Quiet mode.  Suppresses filename display.
  124.  
  125.   /R[Q][D][#]   Using /R by itself will call OFARE if any filenames have
  126.         been changed.  Adding a 'D' after it (no space) will also call
  127.         OFARE if a file has been marked as DELETED which will physically
  128.         remove the DELETED file.  Specifying a number at the end of the
  129.         argument will pass that number as a buffer setting to OFARE.
  130.  
  131. ------------------------------------------------------
  132. Examples (and other information):
  133.  
  134.   OFU *.ARC *.ZIP /A
  135.  
  136.   OFU FILE1.ARC FILE1.ZIP 1 20
  137.  
  138.   OFU NODELIST.A?? NODELIST.Z?? 12 /B1
  139.  
  140.   OFU NODE*.A* *.Z* 6
  141.  
  142.   OFU NODE*.A* *.Z* 6 /RQD20
  143.  
  144.   OFU VIRUS.ZIP 1 /D
  145.  
  146. - Any valid DOS filename can be used, including the DOS wildcard
  147.   characters which should be processed the same way as DOS does.
  148.  
  149. - You can specify up to 64 areas to process on the command-line,
  150.   (if they'll fit) or OFU can process up to 4096 areas when using
  151.   the /A switch.
  152.  
  153. - Generally a small buffer size is best (especially when using /A),
  154.   unless you have exceptionally large file areas (over 200 files per
  155.   area).  You shouldn't ever need to change the buffer size from the
  156.   default value, but the option is there just in case.
  157.  
  158. - Please be careful with wildcards!  I've tried to screen out the more
  159.   dangerous combinations, but don't rely on my thinking of all possible
  160.   bad wildcard combinations.  The safest thing to do is automatically
  161.   make a backup (or archive) of your database files once a day.  That
  162.   way if something goes wrong you'll have a recent copy of the database.
  163.   If you discover a dangerous (one that makes OFU change filenames
  164.   incorrectly) wildcard combination that gets past OFU, please send me
  165.   Netmail as to the command-line and I'll try to add that combination
  166.   to the screening process.  Thank you.
  167.  
  168. ------------------------------------------------------
  169.  
  170. -={**}=-
  171.     Thank You for taking your time to read this, and use my program.
  172. If you have any comments or suggestions, I'd like to hear from you.
  173. Please contact me if you have any problems, or you would like to see
  174. any added features.  You may contact me (via NetMail) at the phone
  175. number (or Net Addresses) listed below.  I also read the NEWOPUS and
  176. MEADOW Echo's.  The latest version of my software is also available
  177. on my BBS.  It may be requested with the magic name of OFU.
  178.  
  179.                                 --=={ Kevin Silcox ------
  180.                                 SysOp of:
  181.                                     StormFront
  182.                                     in Orangevale, California
  183.                                     (916) 988-0407
  184.                                     FidoNet (1:203/407.0)
  185.                                     CalNet (49:916/407.0)
  186.  
  187.                                 BBS Hours:
  188.                                           24 hours a day,
  189.                                     excluding National Mail Hour:
  190.                                       1:00 a.m to 2:00 a.m PST
  191.  
  192.     Special Thanks to my Beta Test Team and the Opus Utility Team.
  193.  
  194.